Vcenter NamespaceManagement SupervisorServices ClusterSupervisorServices CreateSpec

Vcenter NamespaceManagement SupervisorServices ClusterSupervisorServices CreateSpec
Vcenter NamespaceManagement SupervisorServices ClusterSupervisorServices CreateSpec

This schema is deprecated as of vSphere API 9.0.0.0.

The Vcenter NamespaceManagement SupervisorServices ClusterSupervisorServices CreateSpec schema provides a specification required to create a Supervisor Service on a vSphere Supervisor.

This schema was added in vSphere API 7.0.3.0.

JSON Example
{
    "supervisor_service": "string",
    "version": "string",
    "service_config": {
        "service_config": "string"
    },
    "yaml_service_config": "string"
}
string
supervisor_service
Required

This property is deprecated as of vSphere API 9.0.0.0.

Identifier of the Supervisor Service. This Supervisor Service must be in the ACTIVATED state.

This property was added in vSphere API 7.0.3.0.

When clients pass a value of this schema as a parameter, the property must be an identifier for the resource type: com.vmware.vcenter.namespace_management.SupervisorService. When operations return a value of this schema as a response, the property will be an identifier for the resource type: com.vmware.vcenter.namespace_management.SupervisorService.

string
version
Required

This property is deprecated as of vSphere API 9.0.0.0.

Identifier of the Supervisor Service version which contains the service definition. This Supervisor Service version must be in the ACTIVATED state.

This property was added in vSphere API 7.0.3.0.

When clients pass a value of this schema as a parameter, the property must be an identifier for the resource type: com.vmware.vcenter.namespace_management.supervisor_services.Version. When operations return a value of this schema as a response, the property will be an identifier for the resource type: com.vmware.vcenter.namespace_management.supervisor_services.Version.

object
service_config
Optional

This property is deprecated as of vSphere API 9.0.0.0.

A generic key-value map for additional configuration parameters required during service creation. As an example, a third party operator might reference a private registry using parameters such as "registryName" for the registry name, "registryUsername" and "registryPassword" for the registry credentials.

This property was added in vSphere API 7.0.3.0.

If missing or null, no additional configuration parameters will be applied when installing a Supervisor Service in the vSphere Supervisor.

string
yaml_service_config
Optional

This property is deprecated as of vSphere API 9.0.0.0.

A set of additional configuration parameters to be applied during service creation. These parameters should be formatted as a base64 encoded YAML document.

Parameters should be set in at most one of service_config or yaml_service_config, and not both. The yaml_service_config supports complex data types and nested properties.

This property was added in vSphere API 8.0.0.1.

If missing or null, no additional configuration parameters will be applied when installing a Supervisor Service in the vSphere Supervisor.